Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize doc index, add pointer guide #11364

Merged
merged 4 commits into from
Jan 8, 2014
Merged

Reorganize doc index, add pointer guide #11364

merged 4 commits into from
Jan 8, 2014

Conversation

brson
Copy link
Contributor

@brson brson commented Jan 7, 2014

This reorganizes the documentation index to be more focused on the in-tree docs, and to clean up the style, and it also adds @steveklabnik's pointer guide.

}
~~~

But won't this be inefficent? Well, that's a complicated question, but it's
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inefficiency isn't the only reason to pass by reference: ownership is the main one, and I feel this section is totally ignoring that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed; most tutorial (e.g. for C) introduce pointers as a way to pass a variable to a function to edit it directly (well also as a way to workaround the inability to return multiple values in the case of C, which does not have tuples).

Maybe this can be adressed later on.

@steveklabnik
Copy link
Member

Thanks for the spellcheck everyone! At the time I wrote this, I thought it was enabled, but wasn't. :/ Yay typos!

All these changes seem good.

@brson
Copy link
Contributor Author

brson commented Jan 7, 2014

I will make all the recommended changes in a followup.

bors added a commit that referenced this pull request Jan 7, 2014
This reorganizes the documentation index to be more focused on the in-tree docs, and to clean up the style, and it also adds @steveklabnik's pointer guide.
@bors bors closed this Jan 8, 2014
@bors bors merged commit 280553c into rust-lang:master Jan 8, 2014
@brson
Copy link
Contributor Author

brson commented Jan 8, 2014

It looks like these comments are addressed in #11388?

huonw added a commit to huonw/rust that referenced this pull request Jan 8, 2014
@huonw
Copy link
Member

huonw commented Jan 8, 2014

Not all. But I think #11397 addresses the rest.

brson pushed a commit to brson/rust that referenced this pull request Jan 8, 2014
@eastwood
Copy link
Contributor

eastwood commented Jan 8, 2014

Can confirm, #11397 addresses all of the typos and markdown errors that I could find.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants